Skip to content

fix: check for audienceStrict being true #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: check for audienceStrict being true #6

wants to merge 3 commits into from

Conversation

calthejuggler
Copy link

@calthejuggler calthejuggler commented Apr 8, 2025 •
edited by coderabbitai bot
Loading

This PR fixes a bug where we were checking for audienceStrict being set, but not whether it was true or not.

Summary by CodeRabbit

  • New Features

    • Introduced a new JSON structure for experiments, enhancing testing capabilities with detailed audience targeting attributes.

  • Bug Fixes

    • Refined variant assignment logic to ensure that treatments accurately reflect audience targeting criteria, preventing unintended outcomes.

  • Tests

    • Added multiple test methods to improve coverage for audience mismatch scenarios and strict mode handling.

  • Chores

    • Updated the version constant to 1.0.4 for the Client class.
    • Enhanced the flexibility of the setupRequest method to accept null values for data.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 8, 2025 •
edited
Loading

Walkthrough

The changes refine the logic in the assignment process by updating the condition in the getAssignment method of the Context class. Now, the variant is set to 0 only when audienceStrict is both set and explicitly true, and an audience mismatch exists. The pull request also introduces new test methods for explicit false strict mode scenarios in treatment and variable retrieval. Additionally, a new JSON fixture containing multiple experiments and associated audience configurations has been added, along with a modification to the setupRequest method to accept null values for the $data parameter.

Changes

File(s) Change Summary
src/Context/Context.php Updated the getAssignment method logic: now requires audienceStrict to be explicitly true along with a non-empty audienceMismatch to set the variant to 0.
tests/Context/ContextTest.php Added four new test methods: testPeekTreatmentReturnsAssignedVariantOnAudienceMismatchWithExplicitFalseStrictMode(), testGetTreatmentWithMatchingAudienceAndExplicitFalseStrictMode(), testPeekVariableValueReturnsAssignedVariantOnAudienceMismatchWithExplicitFalseStrictMode(), and testGetVariableValueWithMatchingAudienceAndExplicitFalseStrictMode().
tests/Fixtures/json/…/audience_false_strict_context.json Introduced a new JSON file containing a structured representation of multiple experiments with configurations including audienceStrict, audience criteria, and various experimental attributes.
src/Http/HTTPClient.php Modified the setupRequest method signature to allow the $data parameter to accept either a string or null.
src/Client/Client.php Updated the VERSION constant from 1.0.3 to 1.0.4.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Context
    participant Assignment
    Client->>Context: getAssignment()
    Context->>Context: Check if "audienceStrict" is set and explicitly true
    Context->>Context: Evaluate presence of "audienceMismatch"
    alt Conditions met
        Context->>Assignment: Set variant to 0
    else Conditions not met
        Context->>Assignment: Do not change variant
    end
    Context-->>Client: Return assignment object
Loading

Poem

I hopped along through lines of code,
Where strict checks form a new road.
With tests in tow and JSON in sight,
Our experiments shine with clearer light.
Cheers from a rabbit—hopping in delight! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd217b5 and 493b8b0.

📒 Files selected for processing (1)
  • src/Client/Client.php (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/Client/Client.php
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hermeswaldemarin hermeswaldemarin hermeswaldemarin approved these changes

@marcio-absmartly marcio-absmartly Awaiting requested review from marcio-absmartly

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@calthejuggler @hermeswaldemarin